Copyright: Copyright 1993, 1994, 1995 G.Plowman


About Dialog

Purpose

The About Dialog displays version and copyright information about this version of the System Administrator application.

Available from

Help/About menu option


Browse Dialog

Purpose

The Browse Dialog enables the user to search for a journal file.

Available from

Browse button on System Options Dialog

Comments

The Browse dialog is a standard Windows 'File Open' dialog and enables the user to search for a location to place a new journal file, or to select an existing file to be the new journal file.

Library Manager always appends journal information to the end of the journal file - it never deletes the file.


Configuring Library Manager

Library Manager Databases

Library Manager uses standard Clipper format .DBF database files and .NTX index files. It uses the Codebase 5.1 library from Sequiter Software as its database management engine.

When first installed, Library Manager automatically configures itself to place its databases in the \LIBMAN\LIBRARY directory on the drive on which you selected to install the software. (or LIBRARY under the subdirectory you entered during installation).

It is possible to configure Library Manager to use a different directory for the databases by changing settings in the LIBMAN.INI file:

[Install]

Library=C:\LIBMAN\LIBRARY

TempPath=C:\WINDOWS\TEMP

The 'Library' entry is the directory where database files will be stored. 'TempPath' is the directory which will be used for storage of temporary files used during booking and viewing operations - this should be on a local hard disk.

Note that when Library Manager is first installed, the Library directory is created as a sub-directory of the software itself, however, this can be changed using the Library Locator Utility.

When Library Manager is first run, it checks the 'Library' setting directory for its databases and if not found, automatically creates the components of the database sub-system which are missing in that directory. If indexes are deleted, they are automatically recreated.

It is therefore possible for different users in a network environment to use different directories for their work. You might want to do this on a project basis. You can therefore switch between databases.

However, Library Manager has been designed with team working in mind and has the ability to partition data on a project basis. By switching the .INI file you will not obtain the full benefits Library Manager can offer. The Library Locator Utility has been supplied to automate the process of changing the .INI file.

IMPORTANT NOTICE

As with any mission critical data, it is important that you back-up all of the Library Manager databases on a regular basis, preferably on a cyclical basis. If your libraries are stored on a network, then this will probably be done for you by your network administrator.

In this way, if your Library Manager databases become corrupted for any reason you can restore them to a previous state. Note that index corruptions can be corrected by using the System Administrator program Housekeeping facility or by simply deleting the indexes.

File types

Library Manager is supplied with a number of default file types which it will recognise. Unrecognised file types are always treated as binary files.

When a project is created with Library Manager, it is automatically assigned a list of these default file types.

To change the list of defaults or add more types (there is no limit on the number you can have) you must edit the LIBMAN.INI file. Following is an extract:

[FileTypes]

Type1=BAS A '

Type2=BAT A REM

Type3=BMP B

Type4=C A /* */

Type5=CH A * * ***** *****

The '=' sign is followed by the file extension. This is used by Library Manager to identify the file type. It is followed by a space and then an 'A' (for ASCII) or a 'B' (for BINARY).

Library Manager places ASCII files in its databases in order to obtain an efficient means of providing back versions of files by only recording changes and to provide reporting facilities. ASCII files are those files which you can read and edit with a standard ASCII file editor. BINARY files are those which cannot be read or edited such as executeable programs.

It is most important that you get file types correct because attempts to handle binary files as ascii will crash Library Manager.

Please note that Visual Basic offers the ability to save files in text or binary form and uses the same file extensions for both - not very sensible! If in doubt, configure Library Manager to treat a file as binary.

After the 'A' or 'B' follows four strings, separated by spaces, all four strings being optional. These strings are used by Library Manager when it automatically maintains source code comments about versions and module information.

The strings are sequences of characters as follows:

The start of comment marker

The end of comment marker

The start of block marker

The end of block marker

Block markers are used by the 'File Headers' report in Library Manager. If you mark the start of all your functions in your code with some kind of header block, then using the block markers, Library Manager can create a report of all the functions in your modules.

Once a project has been created, you can select the Project/File Types menu option in Library Manager and change/maintain all of the file types allocated to a specific project. You will have to do this if you choose block markers which contain spaces since spaces are used in the .INI file to denote separators.

SHARE.EXE

If Library Manager is to be operated on a local hard disk, the DOS SHARE.EXE program must be installed in your AUTOEXEC.BAT file.


Contents Page

Contents for System Administrator Help

System Adminstrator is a program for performing database administration functions for the Library Manager application.

To learn how to use Help, press the F1 key.

  Main Application Window

  Database Locking

  Configuring Library Manager

  Library Locator Utility

  Library Manager Help

  Other Products Available

  What is Shareware ? - Description and Disclaimer

  Contacting the Author

  Help File Copyright


Copyright
This Windows Help file was written by Graham Plowman

using HelpBuilder Version 1.07 and refers to:

System Administrator Version 1.00 / 25-3-1995

Copyright 1993, 1994, 1995 G.Plowman


Housekeeping Confirmation
Database Housekeeping Confirmation

This confirmation appears when the user has selected to perform housekeeping on the Library Manager system databases.

Housekeeping removes all deleted records from the databases and recreates the indexes on those databases. It effectively 'tidies' the databases up by removing data no longer required.

Answer 'Yes' to proceed with the Housekeeping.

Answer 'No' to stop and not proceed with Housekeeping.

Warning: Housekeeping can be a time consuming operation, particularly on large databases or slow networks.


Refresh Interval Dialog

Purpose

Enables the user of the System Administrator program to set the time interval between refreshes of the list of locks.

Available from

Refresh/Refresh Interval menu option

Comments

Every few seconds, the Library Manager administrator program refreshes the list of locks currently held on the databases to reflect the most current status. The Refresh Interval Dialog enables the user to change the rate at which this occurs. The larger the number entered, the longer the interval. The number must be from 0 to 65535 inclusive.


Integer Too Big Error

This error message appears when an integer number has been entered in a field and is out of the expected range.

Typically, this error occurs when numbers larger than 65535 are entered.


Invalid Integer Error

This error occurs when an invalid number has been entered in a field where an integer is expected.

An integer number only consists of the numeric digits 0-9. No other characters are allowed, otherwise the above error will occur.


Library Locator Utility

The Library Locator Utility has been provided to ease the process of configuring Library Manager to use different directories for its databases.

When the utility is run, its main window will appear.

At the top the currently configured Library is displayed. Below this is the current directory and below this is a small discription which displays whether the Locator Utility recognises the current directory as being a Library Manager library directory. This is determined by checking for the presence of Library Manager database files.

A list of directories available from the current directory is shown. This list is used to navigate your drives and directories in your search for Library Manager databases.

Below the list of directories is a list of previously used directories - those which you have selected before. If you double click on these with the mouse or press the Enter key on the required item, that directory will be configured in LIBMAN.INI as discussed in Configuring Library Manager.

To select a directory, use the directory list to navigate to the required directory. Then press the Save button. This will add the selected directory to the list of previously used directories and configure Library Manager appropriately. Press the Exit button to leave the Locator Utility.

If the list of previously used directories contains directories you no longer require you can remove them from the list by clicking once on them and pressing the Delete button. This removes the item from the list. It does NOT remove the directory or its contents.

If you simply wish to remove items and not change the current Library Manager directory, press the Save List button to save the list for next time and then press the Exit button to leave the Locator Utility.

It is possible to select a directory which is not recognised as a Library Manager database directory. If you do this, when you run Library Manager, it will automatically create its databases in that directory ready for use. This makes the process of creating new database directories significantly easier.


Locks Present Error

This error occurs when an attempt is made to perform a database maintenence function with System Administrator when there are still other users using Library Manager who have locks on the database.

To perform maintenence functions you must set the system administrator lock and wait until every user has released their locks. The system administrator lock prevents users from obtaining any more locks - it disables Library Manager until it is released.

Alternatively, you can manually remove any locks using System Administrator but it is adviseable to set the system administrator lock first.


Database Locking

Library Manager uses database locks as a method of restricting users from performing actions on the version control database while other users are doing so. Often, in this situation to allow such actions would cause loss of integrity to the databases.

Library Manager implements two types of locks:

Single user locks

Multiple user locks

Single user locks are those where only one user can perform an action on the version control database at any one time, such as booking files.

Multiple user locks are those where several users can perform the same action at the same time, but they must be using different projects in order to do so.

You can tell which type a lock is by looking at the System Administrator application main window since it displays the types of locks held by each user. Those which appear more than once are Multiple User locks.

Note

Although Library Manager uses database locks and is designed to operate in a networked environment, it will operate quite happily as a single user system on a local hard disk, however, you must ensure that SHARE.EXE has been installed in your AUTOEXEC.BAT.


System Administrator Logon

Purpose

The Logon Dialog is used to provide a front-end security system for the System Administrator application.

Available from

Appears upon starting the System Administrator application

Comments

The Library Manager application has an in-built security system which enables various access rights to be given on a user-by-user basis. In order to determine the rights available to a user, they must log on via the Logon Dialog.

Note that only users who have System Administrator access rights will be allowed into the System Administrator application.


Low Disk Space Warning

Purpose

This warning appears whenever the System Administrator application identifies that the local disk or the Library disk space availability has fallen below the configured minimum.

It is recommended that the Library Manager application is not used after this warning appears until more space is made available on the appropriate disk or Housekeeping is performed.

To set the 'threshold' below which this warning appears, please see the System Options Dialog.


Main Application Window

Purpose

The main application window of System Administrator appears when the application is first started up and remains on the screen until the application is either minimised or closed.

The main window displays the current status of all the locks active on the version control system database.

The list of locks is refreshed every few seconds to reflect an up-to-date status.

Comments

At the top of the System Administrator main window is the menu and a toolbar. Toolbar options may be selected by simply pressing the appropriate button with the mouse. All of the toolbar options are duplicated on pulldown menu options.

At the bottom of the main window is the status bar. It displays messages about System Administrator's current activity. It also displays a brief description of menu options when they are highlighted on a pulldown menu.

Both the toolbar and status bars may be removed/activated by selecting the appropriate option from the View menu.

To close the System Administrator main window and therefore exit the application, either press Ctrl+F4 or use the mouse to double click on the system menu icon or select the Lock/Exit menu option.


No Access Rights Error

Purpose

This message warns the user that they do not have the required access rights to the System Administrator program.

Available from

Appears after the System Administrator Logon screen

Comments

To obtain rights to use the System Administrator program, please see your System Supervisor/Administrator.


Not Enough File Handles Error

Purpose

The warning appears when the System Administrator program is unable to obtain the required number of file handles to be able to run.

Available from

Appears upon application startup

Comments

If this message appears, you should not proceed to use the System Administrator application, but instead close down any other Windows applications which may be currently running.


Password Maintenence Dialog

Purpose

The Password Maintenence Dialog enables the system administrator to allocate logon IDs for users to be able to use the Library Manager application and to configure the facilities which each user will have permission to use.

Available from

Options/Password Maintenence menu option

Fifth toolbar button

Comments

Every user of the Library Manager application must be allocted their own logon ID and password.

The dialog contains the following fields:

Registered Users

This list displays all the user IDs which are currently defined to the Library Manager password system.

UserID

This field is used to specify the User ID of a user. It may be any sequence of alphabetic characters. This field is required to be entered.

Password

Within this field a user's password is specified. It must be at least six characters in length and is required.

Facilities

This list displays all of the facilities within the Library Manager application which can be enabled/disabled from a user on an individual basis. To enable a user to perform the activities listed, use the mouse to highlight one, more or all of the required activities.

If a user is not given a particular facility, the appropriate menu option in Library Manager will be unavailable to them when they log on.

To add a new user, enter the user ID and password in the appropriate fields. Select the facilties which the user will be able to perform and then press the New button. The new user will appear in the list of Registered Users.

To modify a user, either double click on the required user in the Registered Users list or highlight the user and press the Select button. The user details will then be moved to the fields for editing. When appropriate modifications have been made, press the Update button to store the user back in the list of Registered Users.

To delete a user from the system, select the user record as above and then press the Delete button. Deleting a user only marks the record as deleted. It does not remove the record, but it does prevent the user accessing Library Manager. The record will continue to be visible in the Password Maintenence dialog. To remove deleted user records from the password database, press the Pack button.

To exit the dialog, press the Cancel button. Please note that user records are updated immediately in the password database when the Add/Update/Delete buttons are used.

When the Library Manager application is first run and it creates all of its databases within a directory, it does not create a password database. This must be done using the System Administrator Utility via the Password Maintenence dialog. If a password database cannot be found, the dialog automatically creates one and a message will appear advising of this. If no password file is present, no-one will be able to logon to Library Manager except the user SYSADM using password SYSADM.

It is therefore possible to have individual users defined to individual Library Manager database libraries, increasing security.


Database Recreation Confirmation

This confirmation appears when the user has selected to recreate all of the Library Manager system databases.

Recreating the databases will completely destroy all versions of every file and every project so far created by the Library Manager application.

VERY IMPORTANT NOTE

It is imperitive that you are sure you wish to continue with this facility because it will completely loose all of your work and you will not be able to recover it afterwards.

Answer 'Yes' to proceed with recreating the databases.

Answer 'No' to stop and not proceed with recreating the databases.

Comments

This facility is provided so that the system administrator can create a completely new environment for a user. Under Library Manager, it is possible to have more than one directory containing Library Manager databases. Please see the section on Configuring Library Manager for more information.


Database Reindexing Confirmation

This confirmation appears when the user has selected to reindex the Library Manager system databases.

Recreating the indexes is usually only necessary when it is suspected that corruption has occured. It is also done as part of Housekeeping.

Answer 'Yes' to proceed with recreating the indexes.

Answer 'No' to stop and not proceed recreating the indexes.

Warning: Recreating indexes can be a time consuming operation, particularly on large databases or slow networks.


Release Locks Confirmation

This confirmation appears when the user has selected to manually remove database locks.

Removing locks should only be done when it is known that a particular user is no longer using a facility yet their lock is still present.

IMPORTANT NOTE

Removing locks unnecessarily can cause users to be able to do things at the same time as other users when they would not normally be allowed to. This situation can result in database corruption and loss of data.

This facility is purely provided for emergency use only.

If you wish to stop all users using the system, set the system administrator lock on the Lock menu and wait until all of the user locks have disappeared. The system administrator lock stops users from continuing to use Library Manager until the lock is released.


System Options Dialog

Purpose

The System Options Dialog enables the system administrator to set the following system-wide features:

The Library Manager Audit file (database specific)

The low disk space threshold

Available from

Options/System Options menu option

Comments

The Library Manager Audit file it the file to which all repository activity will be reported. If left blank, no audit file will be created. The audit file will record activity for an entire repository, that is, every project within a particalar database directory.

The low disk space threshold is the amount of disk space in bytes below which Library Manager will report warnings of low disk space availability.


Contacting the Author

Graham Plowman can be contacted by post at the following address:

'Fiddlers Rest', Gaveston Hall Drive, Nuthurst,

Horsham, West Sussex, RH13 6RG, England.

Graham can also be contacted on Compuserve ID: 100105,536


Integrity Check
Integrity Checking

This application has an automatic self-checking feature to advise of corruption to the executeable file.

The main purpose of this is to enable the program to identify whether it has been interfered with, either by a binary file editor or a computer virus.

Note that attempts to change icons and messages etc using products such as App Studio or Resource Workshop will render this application unuseable since they will cause a failure of the check.

If the application executeable is corrupted in any way, the following message will appear:

Integrity Check Violation Error: Integrity has been violated!

If this message does appear, you should re-install this application after checking the reason for it occuring.

Note that all of the author's software is Virus Checked before it is distributed.

Other integrity-related messages are possible. If you need assistance, please contact the author, either directly of via Compuserve ID: 100105,536.


Other Products Available
Products Available from the Same Author

The following products are all available from the same author:

Help Builder

HelpBuilder is a Microsoft Windows 3.1 application for creating and maintaining Windows Help files and is aimed at developers wishing to create Windows Help files to distribute with their products.

This help file was created using Help Builder.

The application is not an 'add-on' to a commercially available word processor, rather, a Multiple Document Interface (MDI) application integrated with the Microsoft HC31.EXE help compiler (or equivalent compatible)(HelpBuilder is configureable). Since it is likely that anyone using this product is likely to be an applications developer using Visual Basic, Microsoft C/C++ or Borland C++ they will already have HC31.EXE as it is supplied with these products.

HelpBuilder does not 'shell' out to DOS to compile files but provides a complete integrated Windows hosted compilation process.

Windows Help and Help Compiler Features Supported

 Topic pages

 Links and 'popup' windows to other topics, including optional 'picture hotspots'

 Browse sequence support

 Ability to place bitmaps in help files

 Fonts, colours, bold and italic text

 Header files

 Context identifiers

 Locking of and changing colour of top of Windows Help page

 Start up macros

 Changing of 'locked' and client 'area' colours in Windows Help

 Compiler configuration - warning levels, CD ROM, compression etc

Product Features

 Full keyword support

 Projects to group individual topic files for a specific application

 Topics held in separate files in order that they may be shared between projects

 Toolbar selection of many facilities and status bars

 Error checking on project building

 Self-checking executeable - to detect corruption/tampering eg Virus

 Project Wizard to create a basic project

 Application Installation and De-installation procedure

 Printing of topics and projects

 Fully integrated and context sensitive Windows Help file including 'How to..' section

 Can create Help files for VB, C/C++, PowerBuilder etc - any language supporting Windows Help and passing of context numbers

 Ability to insert RTF commands

 Network locking on project and topic files

 Automatic creation of .HPJ and .RTF files

 Sample demonstration help file project

 Multi-tasking during compilation - no 'DOS' windows!

 Helpfiles 'testable' from within HelpBuilder

 Configurable compiler - via application .INI file

 Topic locator

 Importing of Norton Guides help projects

Setup Builder

Setup Builder is a Windows 3.1 application for creating and maintaining Windows Hosted installation procedures and is aimed at developers who wish to provide that 'professional' touch to the installation of their software.

The installation procedure for this piece of software was created using Setup Builder.

The interpreter part of the product can also be used to run Windows Hosted DOS-like batch files using the script language supported.

Forget about distributing Microsoft's 0.5 Mb offering just to install a 100-200K executable! This product uses about 80K of diskette space and is highly tailorable and doesn't require the user to get involved with C/C++ or Visual Basic in order to create install disks.

Setup Builder Application Features

 Setup projects to which files can be added/removed

 Automatic creation of installation disks, requesting extra disks as required

 Automatic creation of install script code

 Ability for user to place 'user-defined' code in install procedure if required

 Windows hosted with toolbar and status bar

 All files can have attributes set: target location, overwrite checks, in use checks, file compression (requires MS COMPRESS.EXE), create program manager icons etc

 Ability to create program manager groups

 Up to 500 files in an installation

 Optional encription of install scripts (so that users can't change them)

 Context sensitive, comprehensive Windows Help file

 Network locking on project files

Interpreter Supported Features (this is placed on install disks to 'run' install procedures)

 Script language (similar to DOS batch files) supporting if and goto statements, string and numeric variables

 Windows extensions - predefined dialogs (user definedable text), message boxes, creation of program manager icons/groups and ability to delete them

 Comprehensive Windows Help file

 String and numeric manipulation (left, right, mid, +, -, *, /)

 Copying of files

 Optional fuel gauge during copying

 Date and time functions

 DOS file management - create/delete/renaming of directories, disk space and file presence checks

 Windows .INI file management

 File management - create/delete/renaming/copying/date & time setting, reading and writing of ASCII files

Library Manager

Library Manager is a Windows 3.1 version control system for management of software source files and configuration management. It provides all the basic functionality expected of a VCS with no fancy 'bells and whistles'. Ease of use and simplicity were major design criteria.

The source code for this application is managed using Library Manager.

Library Manager is better than PVCS from Intersolv! It features:

 MDI User interface displaying current status of all files in a project for ease of use

 Security system to which developers access rights can be configured

 Grouping of files into projects

 Unique use of databases which only records changes to files

 Centralised repository - does not 'protect' a directory like other products which can be 'by-passed' in DOS!

 Project templates - allows grouping of files so that specific versions of an application can be recreated. Also enables files to be grouped within an application, for example, all the files belonging to a particular sub-system

 Binary and Ascii files (configureable by file type)

 Back versions - of both ASCII and binary files

 File change comments

 Reports (change comment history, headers, booked files etc) and printing

 File viewing with no need to book/copy out

 Network aware/locking - any number of users (subject to license)

 Multi-tasking - so you can do other things while booking is in progress!

Assistance/Further Information

If you require any assistance or further information on any of my products, I can be contacted at the following address:

'Fiddlers Rest', Gaveston Hall Drive, Nuthurst,

Horsham, West Sussex, RH13 6RG, ENGLAND

I can also be contacted on Compuserve ID: 100105,536

Graham Plowman


What is Shareware ?

Definition of Shareware

Shareware distribution gives users a chance to try software before buying it. If you try a Shareware program and continue using it, you are expected to register. Individual programs differ on details: some request registration while others require it, some specify a maximum trial period. With registration, you get anything from the simple right to continue using the software to an updated program with printed manual.

Copyright laws apply to both Shareware and commercial software, and the copyright holder retains all rights. Shareware authors are accomplished programmers, just like commercial authors, and the programs are of comparable quality. (In both cases, there are good programs and bad ones!) The main difference is in the method of distribution. The author specifically grants the right to copy and distribute the software, either to all and sundry or to a specific group. For example, some authors require written permission before a commercial disk vendor may copy their Shareware.

Shareware is a distribution method, not a type of software. You should find software that suits your needs and pocketbook, whether it's commercial or Shareware. The Shareware system makes fitting your needs easier, because you can try before you buy.

And because the overhead is low, prices are low also. Shareware has the ultimate money-back guarantee: if you don't use the product, you don't pay for it.

Disclaimer - Agreement

Users of this software must accept this disclaimer of warranty:

"This software is supplied as is.  The author disclaims all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose.

The author assumes no liability for damages, direct or consequential, which may result from the use of this software."

This software is a "shareware program" and is provided at no charge to the user for evaluation.  Feel free to share it with your friends, but please do not give it away altered or as part of another system.  The essence of "user-supported" software is to provide personal computer users with quality software without high prices, and yet to provide incentive for programmers to continue to develop new products.  If you find this program useful and you wish to continue to use it after a reasonable trial period, you must make a registration payment. The registration fee will license one copy for use on any one computer at any one time.  You must treat this software just like a book.  An example is that this software may be used by any number of people and may be freely moved from one computer location to another, so long as there is no possibility of it being used at one location while it's being used at another.

Just as a book cannot be read by two different people at the same time.

Commercial users of this software must register and pay for their copies within 30 days of first use or their license is withdrawn.  Site-License arrangements may be made by contacting the author.

Anyone distributing this software for any kind of remuneration must first contact the author for authorisation.

In this way the distributor can be kept up-to-date with the latest version of this software.

You are encouraged to pass a copy of this software to your friends for evaluation.  Please encourage them to register their copy if they find that they can use it.  All registered users will receive a copy of the latest version of this program, a license number, free technical support and notifications of upgrades.

Graham Plowman (CIS: 100105, 536)